fix: use external openai NotGiven/Omit types for compatibility#415
Merged
Conversation
When libraries like pydantic-ai pass NOT_GIVEN values from the standard openai package, Portkey's vendored SDK now recognizes them because they use the exact same class. This fixes TypeError: Object of type NotGiven is not JSON serializable errors when using pydantic-ai or similar libraries with Portkey.
There was a problem hiding this comment.
Pull request overview
This PR resolves compatibility issues between Portkey's vendored OpenAI SDK and external libraries (like pydantic-ai) that use the standard openai package's NOT_GIVEN sentinel values. The fix prioritizes importing NotGiven, Omit, and NOT_GIVEN from the external openai package when available, falling back to local definitions only when openai is not installed.
Key changes:
- Added try/except block to import
NotGiven,Omit, andNOT_GIVENfrom external openai package - Ensured compatibility by using the same class instances across packages
- Maintained backward compatibility with standalone usage when openai is not installed
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Still an issue with the latest release of |
kiran-4444
approved these changes
Jul 22, 2026
VisargD
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
When using Portkey with libraries like pydantic-ai that pass
NOT_GIVENvalues from the standard openai package, users encounter:This happens because Portkey's vendored OpenAI SDK defines its own
NotGivenclass, which is a different class from the standard openai'sNotGiven. When pydantic-ai passes values using the standard openai'sNOT_GIVEN, the vendored code doesn't recognize them asNotGiveninstances.Solution
Instead of defining duplicate
NotGivenandOmitclasses in the vendored code, we now:This ensures that when libraries like pydantic-ai pass
NOT_GIVENvalues from the standard openai package, Portkey's vendored SDK recognizes them because they're the exact same class.Testing